Leadtools Send comments on this topic. | Back to Introduction - All Topics | Help Version 15.3.5
GetRowCompressed(Byte[],UInt16[],Int32,Int32,Int32) Method
See Also 
Leadtools Namespace > RasterImage Class > GetRowCompressed Method : GetRowCompressed(Byte[],UInt16[],Int32,Int32,Int32) Method




workBuffer
Optional work buffer. Allocating the work buffer speeds processing if you call this method more than once, because if you do not allocate a work buffer, the method allocates and frees a temporary buffer each time it is called. bytes required = lines * ((Width + 3) * 2). Pass a null reference (Nothing in Visual Basic) to runBuffer if you do not want to use a work buffer.
runBuffer
The output buffer, which will be filled with 1-bit compressed image data.
runBufferOffset
Offset into runBuffer where the copy operation should start.
row
The number of the row to retrieve. The first row is 0, and the last row is 1 less than the image height.
lines
Number of rows to retrieve.
Retrieves one or more rows of 1-bit compressed data from an image that has been loaded in its compressed format.

Syntax

Visual Basic (Declaration) 
<CLSCompliantAttribute(False)>
Public Overloads Sub GetRowCompressed( _
   ByVal workBuffer() As Byte, _
   ByVal runBuffer() As UShort, _
   ByVal runBufferOffset As Integer, _
   ByVal row As Integer, _
   ByVal lines As Integer _
)
Visual Basic (Usage)Copy Code
Dim instance As RasterImage
Dim workBuffer() As Byte
Dim runBuffer() As UShort
Dim runBufferOffset As Integer
Dim row As Integer
Dim lines As Integer
 
instance.GetRowCompressed(workBuffer, runBuffer, runBufferOffset, row, lines)
C# 
[CLSCompliantAttribute(false)]
public void GetRowCompressed( 
   byte[] workBuffer,
   ushort[] runBuffer,
   int runBufferOffset,
   int row,
   int lines
)
Managed Extensions for C++ 
[CLSCompliantAttribute(false)]
public: void GetRowCompressed( 
   byte[]* workBuffer,
   ushort[]* runBuffer,
   int runBufferOffset,
   int row,
   int lines
)
C++/CLI 
[CLSCompliantAttribute(false)]
public:
void GetRowCompressed( 
   array<byte>^ workBuffer,
   array<ushort>^ runBuffer,
   int runBufferOffset,
   int row,
   int lines
)

Parameters

workBuffer
Optional work buffer. Allocating the work buffer speeds processing if you call this method more than once, because if you do not allocate a work buffer, the method allocates and frees a temporary buffer each time it is called. bytes required = lines * ((Width + 3) * 2). Pass a null reference (Nothing in Visual Basic) to runBuffer if you do not want to use a work buffer.
runBuffer
The output buffer, which will be filled with 1-bit compressed image data.
runBufferOffset
Offset into runBuffer where the copy operation should start.
row
The number of the row to retrieve. The first row is 0, and the last row is 1 less than the image height.
lines
Number of rows to retrieve.

Example

This example demonstrates the low-level methods for accessing 1-bit compressed image data. It demonstrates the ability to get and put rows, and the ability to process rows in buffer-to-buffer processing. The result of the function is an the first 50 lines are inverted.

Remarks

This method is available in the (Document/Medical only) Toolkits.

This method is useful for working with 1-bit images that are loaded in their compressed formats for faster loading and display.

For more information, refer to Speeding Up 1-Bit Documents.

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also